feat: add docs snippet sync pipeline and new documentation snippets#1437
Merged
PHOL-DA merged 3 commits intohyperledger-labs:mainfrom Apr 21, 2026
Merged
Conversation
PHOL-DA
reviewed
Mar 10, 2026
Contributor
|
Export config and scripts updated - export config snippet list in sync with main |
Contributor
|
coldice
force-pushed
the
is/add-new-docs-sync-scripts
branch
from
3314d59 to
b449ff1
Compare
…js syntax and tabs for prettier Signed-off-by: Ibo Sy <ibo@b9lab.com>
coldice
force-pushed
the
is/add-new-docs-sync-scripts
branch
from
9b2daa7 to
a127822
Compare
PHOL-DA
approved these changes
Apr 21, 2026
da-tanabe
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a GitHub Actions workflow, extraction script, and export config to automatically sync code snippets from this repo to the canton.network docs repo.
.github/workflows/update-docs-snippets.yml— triggers on pushes tomainthat touchsnippets/orscripts/, runs extraction, uploads artifacts, and triggers an update workflow in the docs repodocs/scripts/generateOutputDocs.js— readsdocs/config/exportConfig.jsonand extracts 78 snippets from source files intodocs-output/*.mdx, supporting full-file, line-range, string-marker, regex-wrap, and JSON-index extraction modesdocs/config/exportConfig.json— maps 78 snippet names to source file locations acrosssnippets/,scripts/, andbash/examplesdocs/wallet-integration-guide/examples/snippets/:submit-with-retry.ts— retry pattern with exponential backoff for ledger contentionquery-active-contracts-by-party.ts— querying active contracts scoped to a party via the SDKfetch-pending-transfer-instructions.ts— fetching pending transfer instructions usingfetchPendingTransferInstructionView()The new snippets follow the existing
snippets.test.tsauto-discovery pattern.Signed-off-by: Ibo Sy ibo@b9lab.com